Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: backtick added around <textarea> input tag in readme file #34813

Merged
merged 3 commits into from
Nov 1, 2021

Conversation

shohag121
Copy link
Contributor

Description

In the Documentation page for @wordpress/dom on developer.wordpress.org is broken because of misrendering <input> and <textarea> tag.

How has this been tested?

Screenshots

Screenshot 2021-09-14 at 8 31 42 PM

Types of changes

Readme text change.

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • I've tested my changes with keyboard and screen readers.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all *.native.js files for terms that need renaming or removal).

@shohag121 shohag121 requested a review from ellatrix as a code owner September 14, 2021 14:42
@github-actions
Copy link

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @shohag121! In case you missed it, we'd love to have you join us in our Slack community, where we hold regularly weekly meetings open to anyone to coordinate with each other.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

@github-actions github-actions bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Sep 14, 2021
@skorasaurus skorasaurus added the [Type] Developer Documentation Documentation for developers label Sep 16, 2021
@skorasaurus
Copy link
Member

Looks good to me; thanks for the contribution.

@shohag121
Copy link
Contributor Author

Hi @ellatrix,

Is there anything that this PR needs as an improvement?
Your feedback is much appreciated.

Thanks.

@ellatrix
Copy link
Member

Looks like you need to rebuild docs. This can be done with npm run docs:build.

@shohag121
Copy link
Contributor Author

Ran npm run docs:build as you instructed but it did not generate manifest.json.
As I did not add any new file, only updated one maybe that's why it is failing at Static Analysis (Linting, License, Type checks...)? (Got the hint from Documentation Contributions Gide)

Got this output at console
Screenshot 2021-10-23 at 4 33 12 PM

Thanks.

@mkaz
Copy link
Member

mkaz commented Oct 26, 2021

@shohag121 The npm run docs:build command will run node ./bin/api-docs/update-api-docs.js and that is resetting your change.

You can confirm by running that command by itself and then do a git status or git diff and see.

The reason it is doing that is because that part of the README.md is auto generated from the source files. To update, you need to update the comments in:

  • packages\dom\src\dom\document-has-text-selection.js
  • packages\dom\src\dom\document-has-uncollapsed-selection.js

After you update the code comments in those files then run npm run docs:build and it should show the README.md updated properly. Commit that and we should be good to go.

Let me know if that makes sense or if you have additional questions.

Copy link
Member

@mkaz mkaz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I rebased and applied the changes to the code comments and looks like it is all passing now.

@mkaz mkaz merged commit 6f02a4d into WordPress:trunk Nov 1, 2021
@github-actions github-actions bot added this to the Gutenberg 11.9 milestone Nov 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants